Domain binds Kanzi subsystems and objects together. More...

#include <kanzi/core.ui/domain/domain.hpp>

Inheritance diagram for kanzi::Domain:

Public Types
using	PluginHandler
	Type alias for plugin loading functionality.

using	ThreadCreationCallback
	Type definition for the thread creation callback.

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
void	appendEventSource (EventSourceSharedPtr eventSource)
	Attach event source.

void	appendGraphicsOutput (GraphicsOutputSharedPtr graphicsOutput)
	Attach graphics output.

void	clearEventSources ()
	Removes all event sources.

void	clearGraphicsOutputs ()
	Removes all graphics outputs.

void	createPreviewTimeline ()
	Create preview timeline context.

void	destroyPreviewTimeline ()
	Destroy preview timeline context.

void	enableEditing (bool enable)
	Enables or disables editing mode.

ColorWorkflow	getColorWorkflow () const
	Gets the currently configured ColorWorkflow.

CompositionManager *	getCompositionManager () const

DebugRenderRegistry *	getDebugRenderRegistry () const

EventSourceSharedPtr	getEventSource (size_t index) const
	Access event sources.

size_t	getEventSourceCount () const
	Access event source count.

FontManager *	getFontManager () const

GraphicsOutputSharedPtr	getGraphicsOutput (size_t index) const
	Access graphics outputs.

size_t	getGraphicsOutputCount () const
	Access graphics output count.

InputMethodManager *	getInputMethodManager () const
	Returns the input method manager of this domain.

MainLoopScheduler *	getMainLoopScheduler () const

detail::MessageDispatcher *	getMessageDispatcher () const

Module *	getModule (string_view name)
	Get Module instance by the name it is registered with.

ObjectFactory *	getObjectFactory () const

ObjectLoader *	getObjectLoader () const

PatchingNotificationHandlerSharedPtr	getPatchingNotificationHandler () const
	Gets the patching notification handler.

PreviewTimelinePlaybackSharedPtr	getPreviewTimelinePlayback () const

DomainProfilerCollection *	getProfilers () const
	Access to the domain profiler objects.

Renderer *	getRenderer () const

Renderer3D *	getRenderer3D () const

ResourceLoaderFactory *	getResourceLoaderFactory () const

ResourceManager *	getResourceManager () const

TimelineClockSharedPtr	getRootTimelineClock () const

TaskDispatcher *	getTaskDispatcher () const
	Returns the task dispatcher of this domain.

TextManager *	getTextManager () const

void	initialize ()
	Initializes the domain.

bool	isEditingEnabled () const

void	loadPlugin (string_view url)
	Dynamically loads a plugin from a file.

void	onThreadCreation (string_view name) const
	Notifies that Kanzi created a thread and the name of the thread.

template<typename TModule >
void	registerModule (string_view name)
	Register a Module.

void	registerModule (string_view name, shared_ptr< Module > module)
	Register a Module.

void	registerPluginHandler (string_view protocol, PluginHandler handler)
	Registers a plugin handler for a given protocol.

void	removeEventSource (size_t index)
	Remove event source.

void	removeGraphicsOutput (size_t index)
	Remove graphics output.

void	setColorWorkflow (ColorWorkflow colorWorkflow)
	Sets the ColorWorkflow that has been configured.

void	setCompositionManager (unique_ptr< CompositionManager > compositionManager)
	Set composition manager.

void	setMainLoopScheduler (MainLoopScheduler *mainLoopScheduler)

void	setOnThreadCreation (ThreadCreationCallback callback)
	On thread creation, Kanzi calls the callback with the internal name that Kanzi assigns to the thread.

void	setPatchingNotificationHandler (PatchingNotificationHandlerSharedPtr handler)
	Sets the patching notification handler.

KZ_NO_DISCARD bool	tryLoadPlugin (string_view url)
	Attempts to dynamically load a plugin from a file.

void	unregisterPluginHandler (string_view protocol)
	Unregisters existing plugin handler for a given protocol.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Member Functions
static Domain *	create ()

static Domain *	createEmpty ()
	Creates an uninitialized domain.

static void	destroy (Domain *domain)

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Attributes
Properties
static PropertyType< string >	ProjectPluginReferencesProperty
	ProjectPluginReferences property.

static PropertyType< bool >	StateToolsEditStateEnabledProperty
	StateToolsEditStateEnabled property.

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

Domain binds Kanzi subsystems and objects together.

All objects and subsystems in Kanzi are associated with a domain when created. Objects in the same domain share access to the same subsystems. Objects from different domains cannot be used together.

Member Typedef Documentation

◆ PluginHandler

using kanzi::Domain::PluginHandler

Type alias for plugin loading functionality.

Parameters

url	URL of the file to load a plugin from. In case this file is a native library, pass just its name without the file extension.
tryLoading	True if failures should be silent, i.e. exceptions should not be thrown.

◆ ThreadCreationCallback

using kanzi::Domain::ThreadCreationCallback

Type definition for the thread creation callback.

Parameters

name	Kanzi name for the thread.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::Domain::makeEditorInfo ( )

inlinestatic

◆ create()

static Domain * kanzi::Domain::create ( )

static

◆ createEmpty()

static Domain * kanzi::Domain::createEmpty ( )

static

Creates an uninitialized domain.

Use initialize() to initialize the returned object.

Returns: A new domain object.

◆ destroy()

static void kanzi::Domain::destroy ( Domain * domain )

static

◆ initialize()

void kanzi::Domain::initialize ( )

Initializes the domain.

◆ getRenderer()

Renderer * kanzi::Domain::getRenderer ( ) const

◆ getRenderer3D()

Renderer3D * kanzi::Domain::getRenderer3D ( ) const

◆ getResourceManager()

ResourceManager * kanzi::Domain::getResourceManager ( ) const

◆ getResourceLoaderFactory()

ResourceLoaderFactory * kanzi::Domain::getResourceLoaderFactory ( ) const

◆ getMessageDispatcher()

detail::MessageDispatcher * kanzi::Domain::getMessageDispatcher ( ) const

◆ getTaskDispatcher()

TaskDispatcher * kanzi::Domain::getTaskDispatcher ( ) const

Returns the task dispatcher of this domain.

You can use the task dispatcher returned by this function to dispatch tasks that the system will execute on the thread of this domain.

See also: TaskDispatcher

◆ getInputMethodManager()

InputMethodManager * kanzi::Domain::getInputMethodManager ( ) const

Returns the input method manager of this domain.

Returns: The input method manager of the domain.

◆ getFontManager()

FontManager * kanzi::Domain::getFontManager ( ) const

◆ getTextManager()

TextManager * kanzi::Domain::getTextManager ( ) const

◆ getObjectFactory()

ObjectFactory * kanzi::Domain::getObjectFactory ( ) const

◆ getObjectLoader()

ObjectLoader * kanzi::Domain::getObjectLoader ( ) const

◆ getRootTimelineClock()

TimelineClockSharedPtr kanzi::Domain::getRootTimelineClock ( ) const

◆ getPreviewTimelinePlayback()

PreviewTimelinePlaybackSharedPtr kanzi::Domain::getPreviewTimelinePlayback ( ) const

◆ getCompositionManager()

CompositionManager * kanzi::Domain::getCompositionManager ( ) const

◆ getDebugRenderRegistry()

DebugRenderRegistry * kanzi::Domain::getDebugRenderRegistry ( ) const

◆ setMainLoopScheduler()

void kanzi::Domain::setMainLoopScheduler ( MainLoopScheduler * mainLoopScheduler )

◆ getMainLoopScheduler()

MainLoopScheduler * kanzi::Domain::getMainLoopScheduler ( ) const

◆ setPatchingNotificationHandler()

void kanzi::Domain::setPatchingNotificationHandler ( PatchingNotificationHandlerSharedPtr handler )

Sets the patching notification handler.

Parameters

handler The patching notification handler to use for notifying about the patching events.

◆ getPatchingNotificationHandler()

PatchingNotificationHandlerSharedPtr kanzi::Domain::getPatchingNotificationHandler ( ) const

Gets the patching notification handler.

Returns: The patching notification handler.

◆ setCompositionManager()

void kanzi::Domain::setCompositionManager ( unique_ptr< CompositionManager > compositionManager )

Set composition manager.

Will take ownership of composition manager passed.

Parameters

compositionManager New composition manager.

◆ registerModule() [1/2]

void kanzi::Domain::registerModule	(	string_view	name,
		shared_ptr< Module >	module )

Register a Module.

Parameters

name	Name of the module.
module	Shared pointer to the module.

◆ registerModule() [2/2]

template<typename TModule >

void kanzi::Domain::registerModule ( string_view name )

inline

Register a Module.

Template Parameters

TModule The module class.

Parameters

name	Name of the module.

◆ getModule()

Module * kanzi::Domain::getModule ( string_view name )

Get Module instance by the name it is registered with.

Parameters

name	Name of the module.

◆ loadPlugin()

void kanzi::Domain::loadPlugin ( string_view url )

Dynamically loads a plugin from a file.

Throws exceptions in cases of failure.

Parameters

url	URL of the file to load a plugin from. In case this file is a native library, pass just its name without the file extension.

◆ tryLoadPlugin()

KZ_NO_DISCARD bool kanzi::Domain::tryLoadPlugin ( string_view url )

Attempts to dynamically load a plugin from a file.

Does not throw exceptions in cases of failure.

Parameters

url	URL of the file to load a plugin from. In case this file is a native library, pass just its name without the file extension.

Returns: False, if the loading fails. True, if the loading succeeds, or module of same name already exists.

Since: Kanzi 3.9.0

◆ registerPluginHandler()

void kanzi::Domain::registerPluginHandler	(	string_view	protocol,
		PluginHandler	handler )

Registers a plugin handler for a given protocol.

Parameters

protocol	The format of the plugin file identified by its extension serves as a protocol. For example "dll" for windows shared libraries.
handler	A plugin handler that implements functionality for loading a plugin from the associated plugin file.

Since: Kanzi 3.9.0

◆ unregisterPluginHandler()

void kanzi::Domain::unregisterPluginHandler ( string_view protocol )

Unregisters existing plugin handler for a given protocol.

Parameters

protocol The format of the plugin file identified by its extension serves as a protocol. For example "dll" for windows shared libraries.

Since: Kanzi 3.9.0

◆ enableEditing()

void kanzi::Domain::enableEditing ( bool enable )

inline

Enables or disables editing mode.

Preview timeline will be created or destroyed depending on whether editing is enabled or not..

◆ isEditingEnabled()

bool kanzi::Domain::isEditingEnabled ( ) const

inline

◆ createPreviewTimeline()

void kanzi::Domain::createPreviewTimeline ( )

Create preview timeline context.

◆ destroyPreviewTimeline()

void kanzi::Domain::destroyPreviewTimeline ( )

Destroy preview timeline context.

◆ setColorWorkflow()

void kanzi::Domain::setColorWorkflow ( ColorWorkflow colorWorkflow )

inline

Sets the ColorWorkflow that has been configured.

◆ getColorWorkflow()

ColorWorkflow kanzi::Domain::getColorWorkflow ( ) const

inline

Gets the currently configured ColorWorkflow.

◆ getGraphicsOutputCount()

size_t kanzi::Domain::getGraphicsOutputCount ( ) const

Access graphics output count.

Returns: Number of attached graphics outputs.

◆ getGraphicsOutput()

GraphicsOutputSharedPtr kanzi::Domain::getGraphicsOutput ( size_t index ) const

Access graphics outputs.

Parameters

index Index of the graphics output to access.

Returns: Shared pointer to the specified graphics output.

◆ appendGraphicsOutput()

void kanzi::Domain::appendGraphicsOutput ( GraphicsOutputSharedPtr graphicsOutput )

Attach graphics output.

Parameters

graphicsOutput Shared pointer to the graphics output to attach.

◆ removeGraphicsOutput()

void kanzi::Domain::removeGraphicsOutput ( size_t index )

Remove graphics output.

Parameters

index Index of the graphics output to remove.

◆ clearGraphicsOutputs()

void kanzi::Domain::clearGraphicsOutputs ( )

Removes all graphics outputs.

◆ getEventSourceCount()

size_t kanzi::Domain::getEventSourceCount ( ) const

Access event source count.

Returns: Number of attached event sources.

◆ getEventSource()

EventSourceSharedPtr kanzi::Domain::getEventSource ( size_t index ) const

Access event sources.

Parameters

index Index of the event source to access.

Returns: Shared pointer to the specified event source.

◆ appendEventSource()

void kanzi::Domain::appendEventSource ( EventSourceSharedPtr eventSource )

Attach event source.

Parameters

eventSource Shared pointer to the event source to attach.

◆ removeEventSource()

void kanzi::Domain::removeEventSource ( size_t index )

Remove event source.

Parameters

index Index of the event source to remove.

◆ clearEventSources()

void kanzi::Domain::clearEventSources ( )

Removes all event sources.

◆ getProfilers()

DomainProfilerCollection * kanzi::Domain::getProfilers ( ) const

inline

Access to the domain profiler objects.

Returns: The domain profiler collection.

◆ setOnThreadCreation()

void kanzi::Domain::setOnThreadCreation ( ThreadCreationCallback callback )

inline

On thread creation, Kanzi calls the callback with the internal name that Kanzi assigns to the thread.

◆ onThreadCreation()

void kanzi::Domain::onThreadCreation ( string_view name ) const

Notifies that Kanzi created a thread and the name of the thread.

Kanzi calls this function on the created thread, and you can use it for thread-specific startup.

Parameters

name	Thread name to set natively and pass to callback.

Member Data Documentation

◆ ProjectPluginReferencesProperty

PropertyType<string> kanzi::Domain::ProjectPluginReferencesProperty

static

ProjectPluginReferences property.

The default value is "".

See also: setProjectPluginReferences(), getProjectPluginReferences()

◆ StateToolsEditStateEnabledProperty

PropertyType<bool> kanzi::Domain::StateToolsEditStateEnabledProperty

static

StateToolsEditStateEnabled property.

The default value is false.

See also: setStateToolsEditStateEnabled(), isStateToolsEditStateEnabled()

The documentation for this class was generated from the following file:

kanzi/core.ui/domain/domain.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PluginHandler

◆ ThreadCreationCallback

Member Function Documentation

◆ makeEditorInfo()

◆ create()

◆ createEmpty()

◆ destroy()

◆ initialize()

◆ getRenderer()

◆ getRenderer3D()

◆ getResourceManager()

◆ getResourceLoaderFactory()

◆ getMessageDispatcher()

◆ getTaskDispatcher()

◆ getInputMethodManager()

◆ getFontManager()

◆ getTextManager()

◆ getObjectFactory()

◆ getObjectLoader()

◆ getRootTimelineClock()

◆ getPreviewTimelinePlayback()

◆ getCompositionManager()

◆ getDebugRenderRegistry()

◆ setMainLoopScheduler()

◆ getMainLoopScheduler()

◆ setPatchingNotificationHandler()

◆ getPatchingNotificationHandler()

◆ setCompositionManager()

◆ registerModule() [1/2]

◆ registerModule() [2/2]

◆ getModule()

◆ loadPlugin()

◆ tryLoadPlugin()

◆ registerPluginHandler()

◆ unregisterPluginHandler()

◆ enableEditing()

◆ isEditingEnabled()

◆ createPreviewTimeline()

◆ destroyPreviewTimeline()

◆ setColorWorkflow()

◆ getColorWorkflow()

◆ getGraphicsOutputCount()

◆ getGraphicsOutput()

◆ appendGraphicsOutput()

◆ removeGraphicsOutput()

◆ clearGraphicsOutputs()

◆ getEventSourceCount()

◆ getEventSource()

◆ appendEventSource()

◆ removeEventSource()

◆ clearEventSources()

◆ getProfilers()

◆ setOnThreadCreation()

◆ onThreadCreation()

Member Data Documentation

◆ ProjectPluginReferencesProperty

◆ StateToolsEditStateEnabledProperty